docs: developer documentation, ADRs, CI fixes#21
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive developer documentation and CI integrity fixes.
Closes #10
Changes
New Files
docs/DEVELOPMENT.md— Complete dev environment setup guide (prerequisites, quick start, Docker Compose, env vars, API server, Reflex UI, testing, troubleshooting)docs/adr/0001-reflex-migration.md— ADR documenting the Streamlit → Reflex migration decision with trade-offsdocs/adr/0002-agent-architecture.md— ADR documenting the multi-agent medical architecture (controller, routing, tools)Updated Files
CONTRIBUTING.md— Added Docker setup, environment variables, Reflex UI instructions, troubleshooting section; updated clone URLs from Med-X-KimiK2-RAG → MedX; linked to DEVELOPMENT.mdpyproject.toml— Added[tool.bandit]config: skip B104 (bind-all-interfaces) with engineering justification (Docker-containerized server).github/workflows/ci.yml— Removed standalone isort step (ruff I001 already handles import sorting; isort and ruff disagree on aliased imports, creating an unresolvable conflict). Added explanatory comment with reference to ruff FAQ.src/medex/api/__init__.py— Consolidated WebSocketMessage aliased import into single block to satisfy ruff I001CI Status
All 4 required CI jobs verified locally:
ruff check src/ tests/— 0 errorsblack --check src/ tests/— 113 files cleanpyteststable tests — 97/97 passedbandit -r src/ -c pyproject.toml -ll— 0 findings (B104 intentionally excluded)Issue #10 Checklist
Gonzalo